home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1993 April: Penguin on DISC / ADC Developer CD (1993-04) (''Penguin On DISC'')_iso / Dev.CD Apr 93.iso / Utilities / MPW Interfaces 7.1 Beta / CIncludes / HyperXCmd.h < prev    next >
Encoding:
C/C++ Source or Header  |  1992-08-28  |  10.0 KB  |  258 lines  |  [TEXT/MPS ]
  1. /*
  2.     HyperXCmd.h
  3.     Definition file for HyperCard XCMDs and XFCNs in C.
  4.     Copyright Apple Computer, Inc.  1987-1991
  5.     All rights reserved
  6.  
  7. *** Warning: This is an alpha version of the Interfaces for Cube-E. 
  8. ***          Things may change.  Caveat Programmer.
  9.  
  10.  
  11. */
  12.  
  13.  
  14. #ifndef    __HYPERXCMD__
  15. #define    __HYPERXCMD__
  16.  
  17.  
  18. /* Unlike the old days, we have to make sure we have some definitions first… */
  19.  
  20. #ifndef  __TYPES__
  21. #include <Types.h>
  22. #endif
  23.  
  24. #ifndef __EVENTS__
  25. #include <Events.h>
  26. #endif
  27.  
  28. #ifndef __TEXTEDIT__
  29. #include <TextEdit.h>
  30. #endif
  31.  
  32. #ifndef __MENUS__
  33. #include <Menus.h>
  34. #endif
  35.  
  36. #ifndef __STANDARDFILE__
  37. #include <StandardFile.h>
  38. #endif
  39.  
  40.  
  41.  
  42. /* result codes */
  43. #define xresSucc                0
  44. #define xresFail                1
  45. #define xresNotImp                2
  46.  
  47. /* XCMDBlock constants for event.what... */
  48. #define xOpenEvt                1000    /* the first event after you are created */
  49. #define xCloseEvt                1001    /* your window is being forced close (Quit?) */
  50. #define xGiveUpEditEvt            1002    /* you are losing Edit... */
  51. #define xGiveUpSoundEvt            1003    /* you are losing the sound channel... */
  52. #define xHidePalettesEvt        1004    /* someone called HideHCPalettes */
  53. #define xShowPalettesEvt        1005    /* someone called ShowHCPalettes */
  54. #define xEditUndo                1100    /* Edit——Undo */
  55. #define xEditCut                1102    /* Edit——Cut */
  56. #define xEditCopy                1103    /* Edit——Copy */
  57. #define xEditPaste                1104    /* Edit——Paste */
  58. #define xEditClear                1105    /* Edit——Clear */
  59. #define xSendEvt                1200    /* script has sent you a message (text) */
  60. #define xSetPropEvt                1201    /* set a window property */
  61. #define xGetPropEvt                1202    /* get a window property */
  62. #define xCursorWithin            1300    /* cursor is within the window */
  63. #define xMenuEvt                1400    /* user has selected an item in your menu */
  64. #define xMBarClickedEvt            1401    /* a menu is about to be shown--update if needed */
  65.  
  66. #define xShowWatchInfoEvt        1501    /* for variable and message watchers */
  67. #define xScriptErrorEvt            1502    /* place the insertion point */
  68. #define xDebugErrorEvt            1503    /* user clicked "Debug" at a complaint */
  69. #define xDebugStepEvt            1504    /* hilite the line */
  70. #define xDebugTraceEvt            1505    /* same as step but tracing */
  71. #define xDebugFinishedEvt        1506    /* script ended */
  72.  
  73. #define paletteProc                2048    /* Windoid with grow box */
  74. #define palNoGrowProc            2052    /* standard Windoid defproc */
  75. #define palZoomProc                2056    /* Windoid with zoom and grow */
  76. #define palZoomNoGrow            2060    /* Windoid with zoom and no grow */
  77. #define hasZoom                    8
  78. #define hasTallTBar                2
  79. #define toggleHilite            1
  80.  
  81.  
  82. #define maxCachedChecks            16        /* maximum number of checkpoints in a script */
  83.  
  84.  
  85. /* paramCount is set to these constants when first calling special XThings */
  86. #define xMessageWatcherID        = -2;
  87. #define xVariableWatcherID        = -3;
  88. #define xScriptEditorID            = -4;
  89. #define xDebuggerID                = -5;
  90.  
  91. /* XTalkObjectPtr->objectKind values */
  92. #define stackObj                1
  93. #define bkgndObj                2
  94. #define cardObj                    3
  95. #define fieldObj                4
  96. #define buttonObj                5
  97.  
  98.  
  99. typedef struct XCmdBlock *XCmdPtr; 
  100. struct XCmdBlock {
  101.     short paramCount;         /* If = -1 then new use for XWindoids */
  102.     Handle params[16];
  103.     Handle returnValue;
  104.     Boolean passFlag;
  105.  
  106.     Ptr entryPoint;             /* to call back to HyperCard */
  107.     short request;
  108.     short result;
  109.     long inArgs[8];
  110.     long outArgs[4];
  111. };
  112.  
  113. typedef struct XWEventInfo *XWEventInfoPtr; 
  114. struct XWEventInfo {
  115.     EventRecord event;
  116.     WindowPtr eventWindow;
  117.     long eventParams[9];
  118.     Handle eventResult;
  119. };
  120.  
  121. typedef struct XTalkObject *XTalkObjectPtr;
  122. struct XTalkObject {
  123.     short objectKind;        /* stack, bkgnd, card, field, or button */
  124.     long stackNum;            /* reference number of the source stack */
  125.     long bkgndID;
  126.     long cardID;
  127.     long buttonID;
  128.     long fieldID;
  129. };
  130.  
  131.  
  132. typedef struct CheckPts *CheckPtPtr;
  133. typedef CheckPtPtr *CheckPtHandle; 
  134. struct CheckPts {
  135.     short checks[maxCachedChecks];
  136. };
  137.  
  138. #ifdef __cplusplus
  139. extern "C" {
  140. #endif
  141.  
  142. /****  HyperTalk Utilities  ****/
  143. pascal Handle EvalExpr(XCmdPtr paramPtr, StringPtr expr);
  144. pascal void SendCardMessage(XCmdPtr paramPtr, StringPtr msg);
  145. pascal void SendHCMessage(XCmdPtr paramPtr, StringPtr msg);
  146. pascal void RunHandler(XCmdPtr paramPtr, Handle handler);
  147.  
  148. /****  Memory Utilities  ****/
  149. pascal Handle GetGlobal(XCmdPtr paramPtr, StringPtr globName);
  150. pascal void SetGlobal(XCmdPtr paramPtr, StringPtr globName, Handle globValue);
  151. pascal void ZeroBytes(XCmdPtr paramPtr, Ptr dstPtr, long longCount);
  152.  
  153. /****  String Utilities  ****/
  154. pascal void ScanToReturn(XCmdPtr paramPtr, Ptr *scanPtr);
  155. pascal void ScanToZero(XCmdPtr paramPtr, Ptr *scanPtr);
  156. pascal Boolean StringEqual(XCmdPtr paramPtr, StringPtr str1, StringPtr str2);
  157. pascal long StringLength(XCmdPtr paramPtr, Ptr strPtr);
  158. pascal Ptr StringMatch(XCmdPtr paramPtr, StringPtr pattern, Ptr target);
  159. pascal void ZeroTermHandle(XCmdPtr paramPtr, Handle hndl);                                
  160.  
  161. /****  String Conversions  ****/
  162. pascal void BoolToStr(XCmdPtr paramPtr, Boolean bool, StringPtr str);
  163. pascal void ExtToStr(XCmdPtr paramPtr, extended80 num, StringPtr str);
  164. pascal void LongToStr(XCmdPtr paramPtr, long posNum, StringPtr str);
  165. pascal void NumToHex(XCmdPtr paramPtr, long num, short nDigits, StringPtr str);
  166. pascal void NumToStr(XCmdPtr paramPtr, long num, StringPtr str);
  167. pascal Handle PasToZero(XCmdPtr paramPtr, StringPtr str);
  168. pascal void PointToStr(XCmdPtr paramPtr, Point pt, StringPtr str);                        
  169. pascal void RectToStr(XCmdPtr paramPtr, Rect *rct, StringPtr str);                        
  170. pascal void ReturnToPas(XCmdPtr paramPtr, Ptr zeroStr, StringPtr pasStr);
  171. pascal Boolean StrToBool(XCmdPtr paramPtr, StringPtr str);
  172. pascal extended80 StrToExt(XCmdPtr paramPtr, StringPtr str);
  173. pascal long StrToLong(XCmdPtr paramPtr, StringPtr str);
  174. pascal long StrToNum(XCmdPtr paramPtr, StringPtr str);
  175. pascal void StrToPoint(XCmdPtr paramPtr, StringPtr str, Point *pt);                        
  176. pascal void StrToRect(XCmdPtr paramPtr, StringPtr str, Rect *rct);                        
  177. pascal void ZeroToPas(XCmdPtr paramPtr, Ptr zeroStr, StringPtr pasStr);
  178.  
  179. /****  Field Utilities  ****/
  180. pascal Handle GetFieldByID(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID);
  181. pascal Handle GetFieldByName(XCmdPtr paramPtr, Boolean cardFieldFlag, StringPtr fieldName);
  182. pascal Handle GetFieldByNum(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldNum);
  183. pascal void SetFieldByID(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID,
  184.     Handle fieldVal);
  185. pascal void SetFieldByName(XCmdPtr paramPtr, Boolean cardFieldFlag,
  186.     StringPtr fieldName, Handle fieldVal);
  187. pascal void SetFieldByNum(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldNum,
  188.     Handle fieldVal);
  189. pascal TEHandle GetFieldTE(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID,
  190.     short fieldNum, StringPtr fieldNamePtr);                                                    
  191. pascal void SetFieldTE(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID,
  192.     short fieldNum, StringPtr fieldNamePtr, TEHandle fieldTE);                                    
  193.  
  194. /****  Miscellaneous Utilities  ****/  /* ALL NEW */
  195. pascal void BeginXSound(XCmdPtr paramPtr, WindowPtr window);
  196. pascal void EndXSound(XCmdPtr paramPtr);
  197. pascal Boolean GetFilePath(XCmdPtr paramPtr, StringPtr fileName, short numTypes, SFTypeList typeList,
  198.     Boolean askUser, OSType *fileType, StringPtr fullName);
  199. pascal void GetXResInfo(XCmdPtr paramPtr, short *resFile, short *resID, ResType *rType, StringPtr name);
  200. pascal void Notify(XCmdPtr paramPtr);
  201. pascal void SendHCEvent(XCmdPtr paramPtr, EventRecord *event);
  202. pascal void SendWindowMessage(XCmdPtr paramPtr, WindowPtr windPtr, 
  203.     StringPtr windowName, Handle msg);
  204. pascal WindowPtr FrontDocWindow(XCmdPtr paramPtr);
  205. pascal long StackNameToNum(XCmdPtr paramPtr, StringPtr stackName);
  206. pascal short ShowHCAlert(XCmdPtr paramPtr, short dlgID, StringPtr promptStr);
  207.  
  208. /****  Creating and Disposing XWindoids  ****/  /* ALL NEW */
  209. pascal WindowPtr NewXWindow(XCmdPtr paramPtr, Rect *boundsRect, StringPtr title, 
  210.    Boolean visible, short procID, Boolean color, Boolean floating);
  211. pascal WindowPtr GetNewXWindow(XCmdPtr paramPtr, ResType templateType, short 
  212.    templateID, Boolean color, Boolean floating);
  213. pascal void CloseXWindow(XCmdPtr paramPtr, WindowPtr window);
  214.  
  215. /****  XWindoid Utilities  ****/  /* ALL NEW */
  216. pascal void HideHCPalettes(XCmdPtr paramPtr);
  217. pascal void ShowHCPalettes(XCmdPtr paramPtr);
  218. pascal void RegisterXWMenu(XCmdPtr paramPtr, WindowPtr window, MenuHandle menu, Boolean registering);
  219. pascal void SetXWIdleTime(XCmdPtr paramPtr, WindowPtr window, long interval);
  220. pascal void XWHasInterruptCode(XCmdPtr paramPtr, WindowPtr window, Boolean haveCode);
  221. pascal void XWAlwaysMoveHigh(XCmdPtr paramPtr, WindowPtr window, Boolean moveHigh);
  222. pascal void XWAllowReEntrancy(XCmdPtr paramPtr, WindowPtr window, Boolean allowSysEvts, Boolean allowHCEvts);
  223.  
  224. /****  Text Editing Utilities  ****/  /* ALL NEW */
  225. pascal void BeginXWEdit(XCmdPtr paramPtr, WindowPtr window);
  226. pascal void EndXWEdit(XCmdPtr paramPtr, WindowPtr window);
  227. pascal Ptr HCWordBreakProc(XCmdPtr paramPtr);
  228. pascal void PrintTEHandle(XCmdPtr paramPtr, TEHandle hTE, StringPtr header);
  229.  
  230. /****  Script Editor support  ****/  /* ALL NEW */
  231. pascal CheckPtHandle GetCheckPoints(XCmdPtr paramPtr);
  232. pascal void SetCheckPoints(XCmdPtr paramPtr, CheckPtHandle checkLines);
  233. pascal void FormatScript(XCmdPtr paramPtr, Handle scriptHndl, long *insertionPoint, Boolean quickFormat);
  234. pascal void SaveXWScript(XCmdPtr paramPtr, Handle scriptHndl);
  235. pascal void GetObjectName(XCmdPtr paramPtr, XTalkObjectPtr object, StringPtr objName);
  236. pascal void GetObjectScript(XCmdPtr paramPtr, XTalkObjectPtr object, Handle *scriptHndl);
  237. pascal void SetObjectScript(XCmdPtr paramPtr, XTalkObjectPtr object, Handle scriptHndl);
  238.  
  239. /****  Debugging Tools support  ****/  /* ALL NEW */
  240. pascal void AbortScript(XCmdPtr paramPtr);
  241. pascal void GoScript(XCmdPtr paramPtr);
  242. pascal void StepScript(XCmdPtr paramPtr, Boolean stepInto);
  243. pascal void CountHandlers(XCmdPtr paramPtr, short *handlerCount);
  244. pascal void GetHandlerInfo(XCmdPtr paramPtr, short handlerNum, StringPtr handlerName, 
  245.                                   StringPtr objectName, short *varCount);
  246. pascal void GetVarInfo(XCmdPtr paramPtr, short handlerNum, short varNum, StringPtr varName, 
  247.                               Boolean *isGlobal, StringPtr varValue, Handle varHndl);
  248. pascal void SetVarValue(XCmdPtr paramPtr, short handlerNum, short varNum, Handle varHndl);
  249. pascal Handle GetStackCrawl(XCmdPtr paramPtr);
  250. pascal void TraceScript(XCmdPtr paramPtr, Boolean traceInto);
  251.  
  252. #ifdef __cplusplus
  253. }
  254. #endif
  255.  
  256.  
  257. #endif
  258.